ATSUGetIndFontTracking

Obtains information about the name code and values of a font tracking in a font.

OSStatus ATSUGetIndFontTracking (
                     ATSUFontID iFontID,
                     ATSUVerticalCharacterType iCharacterOrientation,
                     ItemCount iTrackIndex,
                     Fixed * oFontTrackingValue,
                     FontNameCode * oNameCode);
iFontID
A value of type ATSUFontID. Pass the ID of the font whose font tracking you want to get name information for.

iCharacterOrientation
A value of type ATSUVerticalCharacterType. Pass the glyph orientation of the font tracking whose value you want to obtain. See Glyph Orientation Constants for a description of possible values. You must specify this value because there are different font trackings for different glyph orientations.

iTrackIndex
A 0-based index. Pass a value between 0 and one less than the count passed back in the function ATSUCountFontTracking.

oFontTrackingValue
A pointer to a Fixed value. On return, the font tracking value corresponding to the specified index and character orientation.

oNameCode
A pointer to a value of type FontNameCode. On return, the type of font tracking name. See Font Name Code Constants for a description of possible values. You cannot pass NULL for this parameter.

function result
A result code. The result code kATSUInvalidFontErr indicates that the ID does not correspond to any installed font. For a list of other ATSUI-specific result codes, see Result Codes.
DISCUSSION
The ATSUGetIndFontTracking function obtains, for an indexed font tracking, its value and name code. You can pass this value to the function ATSUFindFontName to find the localized font tracking name identified by this name code. You can call ATSUGetIndFontTracking to iterate through the entries of a font tracking table.

VERSION NOTES
Available beginning with ATSUI 1.1.

© 2000 Apple Computer, Inc. – (Last Updated 25 Jan 00)